DOC: improve pd.Timestamp docs with more examples and clarify differe… #18811
Conversation
mortada
force-pushed
the
pd_timestamp_docs
branch
2 times, most recently
from
c5b149e to
c6305b1
Compare
Codecov Report
@@ Coverage Diff @@
## master #18811 +/- ##
=========================================
Coverage ? 91.62%
=========================================
Files ? 154
Lines ? 51408
Branches ? 0
=========================================
Hits ? 47104
Misses ? 4304
Partials ? 0
Continue to review full report at Codecov.
|
pandas/_libs/tslibs/timestamps.pyx
Outdated
| unit : string | ||
| numpy unit used for conversion, if ts_input is int or float | ||
| unit : str | ||
| Unit used for conversion if ts_input is of type int or float. |
There was a problem hiding this comment.
let's add the valid values (D, h, m, s, ms us, ns)
pandas/_libs/tslibs/timestamps.pyx
Outdated
| @@ -405,9 +406,19 @@ class Timestamp(_Timestamp): | |||
|
|
|||
| Examples | |||
| -------- | |||
| Using the primary calling convention: | |||
|
|
|||
| >>> pd.Timestamp('2017-01-01T12') | |||
| Timestamp('2017-01-01 12:00:00') | |||
|
|
|||
There was a problem hiding this comment.
can you add some commentary before each of these examples
mortada
force-pushed
the
pd_timestamp_docs
branch
from
c6305b1 to
0781c26
Compare
|
@jreback updated, please take a look |
pandas/_libs/tslibs/timestamps.pyx
Outdated
| >>> pd.Timestamp(1513393355, unit='s', tz='US/Pacific') | ||
| Timestamp('2017-12-15 19:02:35-0800', tz='US/Pacific') | ||
|
|
||
| Using the other two forms that minic the API for ``datetime.datetime``: |
There was a problem hiding this comment.
good catch, will fix
| @@ -405,9 +407,23 @@ class Timestamp(_Timestamp): | |||
|
|
|||
| Examples | |||
| -------- | |||
| Using the primary calling convention: | |||
There was a problem hiding this comment.
do we use this nomenclature above? if not can you reconcile
There was a problem hiding this comment.
yes in the above the doc says:
Notes
-----
There are essentially three calling conventions for the constructor. The
primary form accepts four parameters. They can be passed by position or
keyword.
The other two forms mimic the parameters from ``datetime.datetime``. They
can be passed by either position or keyword, but not both mixed together.
…nt forms of API usage
mortada
force-pushed
the
pd_timestamp_docs
branch
from
0781c26 to
dcdf2ab
Compare
|
@jreback PR is updated |
|
thanks! |
…nt forms of API usage